Some GdkMonitor documentation additions
authorMatthias Clasen <mclasen@redhat.com>
Tue, 26 Dec 2017 16:19:24 +0000 (11:19 -0500)
committerMatthias Clasen <mclasen@redhat.com>
Tue, 26 Dec 2017 18:00:27 +0000 (13:00 -0500)
Document the ::invalidated signal.

gdk/gdkmonitor.c

index d36670e8068e7ad260304075a7f464c1ebe85bc6..536e891a8370184bdab957392c3806616660cc11 100644 (file)
  * gdk_display_get_monitor_at_window().
  */
 
+/**
+ * GdkMonitor:
+ *
+ * The GdkMonitor struct contains only private fields and should not
+ * be accessed directly.
+ */
+
 enum {
   PROP_0,
   PROP_DISPLAY,
@@ -247,6 +254,13 @@ gdk_monitor_class_init (GdkMonitorClass *class)
 
   g_object_class_install_properties (object_class, LAST_PROP, props);
 
+  /**
+   * GdkMonitor::invalidate:
+   * @monitor: the object on which this signal was emitted
+   *
+   * The ::invalidate signal gets emitted when the output represented
+   * by @monitor gets disconnected.
+   */
   signals[INVALIDATE] = g_signal_new (g_intern_static_string ("invalidate"),
                                       G_TYPE_FROM_CLASS (object_class),
                                       G_SIGNAL_RUN_FIRST,